JavaScript

A5.ControlBarupdate Method

Syntax

A5.ControlBar.update(path,value[,animation[,fireEvent[,delayRender]]])

Arguments

pathstringarray

A path or array of paths to update. The path is a string with "." representing object sub-properties. For example if the data had an object with the name "customer", and the value of the "id" property of the object was to be changed, the path would be "customer.id".

valueanyarray

The value(s) to put in the corresponding path(s).

animationbooleanstringobject

What animation to perform. To not animate pass in false. If a string is passed in the value of the string is assumed to be the name of the animation to do. If an object is passed in it must conform to the control bar animation object. See A5.ControlBar Animation Object.

fireEventboolean

Whether or not to fire the onChange event after the update.

delayRenderboolean

Whether or not to delay the refresh of the control bar. This is useful if other code may also refresh the control bar and it is desirable to only have one refresh occur.

Description

Update values in the data. A single path and value may be passed in, or an array of paths and values.

Example

// assume cbObj is a pointer to an instance of A5.ControlBar
cbObj.update('title','Customer*') // update the value of the variable "title" to be "Customer*"